Skip to content

docs(support): add self-serve steps to rotate PORTKEY_CLIENT_AUTH - #1173

Merged
bhishmendramahala-crypto merged 2 commits into
mainfrom
docs/rotate-client-auth-self-serve
Nov 12, 2026
Merged

bhishmendramahala-crypto merged 2 commits into
mainfrom
docs/rotate-client-auth-self-serve

Conversation

@bhishmendramahala-crypto

@bhishmendramahala-crypto bhishmendramahala-crypto commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Section 9 of Rotate Credentials and API Keys told hybrid customers to contact support to reissue PORTKEY_CLIENT_AUTH. The key can now be rotated from the dashboard, so this replaces that instruction with the self-serve steps.

  • PORTKEY_CLIENT_AUTH bullet now links to a new Rotate the gateway client auth key subsection
  • New subsection walks through Admin Settings > Gateway Registration > open deployment > Rotate Key > optional Grace period (hours) (0–24, empty = default) > Confirm Rotation > copy the new key (shown once) > update every deployed gateway before the grace period ends
  • Adds three screenshots under images/support/

Not changed: aigw/support/rotate-credentials.mdx still says to contact Palo Alto Networks support, because it's not confirmed that console has the same Gateway Registration flow.

Test plan

  • Ran mint dev locally; preview reported ready with no errors in the server log
  • Reviewer: check the new subsection and the three screenshots render on the preview deployment

Replace the "contact support" instruction for the hybrid gateway client
auth key with the Gateway Registration > Rotate Key flow, including the
grace period option and screenshots.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 12, 2026 18:02
@mintlify

mintlify Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
portkey-docs 🟢 Ready View Preview Nov 12, 2026, 6:12 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The rotation instructions omit optional Data Service instances, leaving them using an expired key after the grace period unless their credentials are updated and the instances restarted.

1 open issue
What changed in this PR

Updates the credential-rotation guide so Portkey hybrid customers can rotate PORTKEY_CLIENT_AUTH through the dashboard instead of contacting support. The Prisma AIRS support workflow remains unchanged.

Changes:

  • Links the client-auth credential entry to a new self-service rotation subsection.
  • Documents Gateway Registration, the optional grace period, and copying the one-time key, with three screenshot references.
  • Instructs customers to update and restart deployed gateways before the old key expires.
File Description
support/​rotate-credentials.mdx Replaces support-mediated client-auth rotation with illustrated dashboard and gateway rollout steps.

Review effort: Balanced

Comment thread support/rotate-credentials.mdx Resolved
Updated instructions for updating deployed gateways and Data Service instances with new authentication keys.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the guide’s update to dashboard self-service credential rotation.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@bhishmendramahala-crypto
bhishmendramahala-crypto merged commit 500b698 into main Nov 12, 2026
4 checks passed

This branch was successfully deployed

1 active deployment
staging — e4f11dd5 Deployed Nov 12, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants